/*
 * Copyright 2017 StreamSets Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.streamsets.pipeline.stage.origin.websocketserver;

import com.streamsets.pipeline.api.Stage;
import com.streamsets.pipeline.api.credential.CredentialValue;
import org.eclipse.jetty.websocket.api.Session;
import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse;

import java.io.IOException;
import java.util.List;

public interface WebSocketReceiver {

  List<Stage.ConfigIssue> init(Stage.Context context);

  void destroy();

  CredentialValue getAppId();

  boolean isAppIdViaQueryParamAllowed();

  String getUriPath();

  int getIdleTimeout();

  boolean validate(ServletUpgradeRequest req, ServletUpgradeResponse res) throws IOException;

  boolean process(Session session, byte[] payload, int offset, int len) throws IOException;

  boolean process(Session session, String message) throws IOException;
}
